﻿
namespace Com.FastSearch.SharePoint.Interfaces
{
    /// <summary>
    /// Definition of a navigator.
    /// </summary>
    public interface IESPNavigatorDefinition
    {
        /// <summary>
        /// The internal name of the navigator.
        /// </summary>
        string Name { get; }

        /// <summary>
        /// The name of the navigator as it should be displayed to users.
        /// </summary>
        string DisplayName { get; }

        /// <summary>
        /// Whether or not the navigator is a scope navigator.
        /// </summary>
        bool IsScopeNavigator { get; }

        /// <summary>
        /// The scope to aggregate over, for navigators where <see cref="IsScopeNavigator"/> is true.
        /// </summary>
        string Scope { get; set; }
    }
}
